MarkLogic Server 11.0 Product Documentation
GET /manage/v2/task-servers/{id|name}/propertiesSummary
This resource address returns the properties of the Task Server in the
specified group.
| URL Parameters |
| format |
The format of the returned data. Can be either
json or xml (default). This value overrides the Accept header if
both are present. |
| group-id |
Specifies to return only the servers in the
specified group. The group can be identified either by id or name. If not specified, the
response includes information about all Task Servers. |
| Request Headers |
| Accept |
The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header. |
| Response Headers |
| Content-type |
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
|
Response
Upon success, MarkLogic Server returns status code 200 (OK). If the Task
Server does not exist, a status code of 400 (Bad Request) is returned. The response body
contains the requested data. A status code of 401 (Unauthorized) is returned if the user does
not have the necessary privileges.
Required Privileges
This operation requires the
manage-user role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
The structure of the output returned from
this REST API is as follows:
threads
The maximum number of server threads allowed on each host in the group;
the server may also additionally limit threads.
debug-threads
The maximum number of debugging threads allowed on each host in the group.
max-time-limit
The upper bound for a request's time limit, in seconds.
default-time-limit
The default time limit for a request, in seconds.
max-inference-size
The upper bound for a request's inference size, in megabytes.
default-inference-size
The default inference size for a request, in megabytes.
queue-size
The maximum number of tasks allowed.
pre-commit-trigger-depth
The maximum depth of pre-commit trigger invocation.
post-commit-trigger-depth
The maximum depth of post-commit trigger invocation.
pre-commit-trigger-limit
The maximum number of triggers a single statement can invoke.
file-log-level
The minimum log level for log messages in the log file.
opsdirector-applog-level
DEPRECATED
log-errors
Log uncaught request processing errors to ErrorLog.txt.
debug-allow
Allow debugging on this server.
profile-allow
Allow profiling on this server.
scheduled-tasks
The scheduled tasks' specifications.
This is a complex structure with the following children:
scheduled-task
A scheduled task specification.
This is a complex structure with the following children:
scheduled-task-relationsThe relations of the scheduled task.
This is a complex structure with the following children:
relationA specific related resource.
This is a complex structure with the following children:
qualifiersA list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifierAnother resource that qualifies the resource.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
rolerefA role that distinguishes the resource.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
relation-idA group or host related to the server.
task-id
The task ID.
task-enabled
Whether or not a task is enabled
task-path
The module to invoke.
task-root
The path to the module directory root.
task-type
What type of scheduled task is this.
task-period
How often this task should run (every n months, weeks, days, hours or minutes).
task-month-day
The day of the month that this task runs on.
task-days
The days that this task runs on.
This is a complex structure with the following children:
task-day
A day that this task runs on.
task-start-date
The starting date (in MM/DD/YYYY notation) for this task.
task-start-time
The starting time (in 24:00 notation) for this task.
task-timestamp
The date and time this task was created.
task-user
The user to run this task as.
task-priority
The priority of this task.
Example
http://localhost:8002/manage/v2/task-servers/Tserver/properties?group-id=Default
==> Returns the properties of the 'Tserver' Task Server in the Default group.
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.